home *** CD-ROM | disk | FTP | other *** search
/ Aminet 16 / Aminet 16 (1996)(GTI - Schatztruhe)[!][Dec 1996].iso / Aminet / comm / net / AmiTrack1_21.lha / AmiTrack / AmiTrack.readme < prev    next >
Text File  |  1996-10-26  |  13KB  |  330 lines
  1. Short: AmiTCP on-line Amiga registry system
  2. Type: comm/net
  3. Author: jfriesne@ucsd.edu (Jeremy Friesner)
  4. Uploader: jfriesne@ucsd.edu (Jeremy Friesner)
  5. Requires: Workbench 2.04+, AmiTCP3.0b+
  6. Replaces: comm/tcp/AmiTrack1.2
  7. Version: 1.21
  8.  
  9. ----------------------------------------------------------------
  10.         
  11.                           AMITRACK V1.21
  12.                      
  13.                         (Released 10/24/96)
  14.                      
  15. ----------------------------------------------------------------
  16.  
  17.  
  18. INTRODUCTION
  19. ------------
  20. What is AmiTrack?  Hmm, good question.
  21.  
  22. I was talking to an AmiPhone user a few weeks ago, and
  23. he was lamenting that it was hard to find another AmiPhone
  24. user who was online to talk to.  We decided what was needed
  25. was a way to find out who else is available, sort of an
  26. "Active Amiga registry".
  27.  
  28. So that's what AmiTrack does.  AmiTrack is an AmiTCP program
  29. that acts as the keeper of a list of Amigas that are currently
  30. on-line.  It isn't limited to just AmiPhone users, either; you
  31. can register your Amiga to advertise any message string you want.
  32.  
  33. This archive contains two executables: AmiTrack and AmiTrackServer.
  34. AmiTrack is a client that you can use to notify the world of your
  35. Amiga's presence on the internet, and AmiTrackServer is useful if
  36. you wish to let people use your Amiga as a registry site.  AmiTrackServer
  37. must be launched from the CLI, but AmiTrack may be launched from
  38. either the CLI or by clicking its icon.
  39.  
  40.  
  41. INSTALLATION
  42. ------------
  43. There isn't any, really.  Just copy the executable files and icons
  44. to wherever you want to keep them.  With the ToolTypes DONOTWAIT and
  45. CX_POPUP=NO set, AmiTrack can go into your WBStartup directory.
  46.  
  47.  
  48. AMITRACK 
  49. --------
  50. The AmiTrack program is designed to connect to an Amiga running
  51. the AmiTrackServer program.  While connected, it periodically
  52. does two things:  it sends "ping" packets to the AmiTrackServer
  53. to let it know that you're still there, and it downloads the
  54. list of currently registered Amigas on that server, for your
  55. viewing pleasure.  When you quit AmiTrack, you will be removed
  56. from the server's list of Amigas.
  57.  
  58. AmiTrack understands the following parameters.  These parameters
  59. may be set either as ToolTypes in AmiTrack's icon, or specified
  60. on the command line (in the same exact format as the tooltypes,
  61. although you may have to use "quote marks" if the parameter 
  62. contains spaces):
  63.  
  64. SERVER/K: 
  65.     The Internet host name of the Amiga that is running AmiTrackServer,
  66.     that you wish to register with.  This defaults to isys.ml.org.
  67.  
  68. PORT/K/N: 
  69.     The port number on the server which you wish to connect to.
  70.     This defaults to port 18945 (which by a bizarre coincidence,
  71.     is also the default port for AmiTrackServer to accept connections
  72.     on)
  73.  
  74. COMMENT/K: 
  75.     The comment string you wish to have associated with your Amiga.
  76.     This defaults to no comment.
  77.  
  78. PINGDELAY/K/N:
  79.     Sets the number of minutes to delay between pinging the AmiTrack
  80.     server.  Defaults to 1.  Setting this to values greater than 4
  81.     are not recommended, as the AmiTrack server will drop you from
  82.     its listing if it hasn't heard from you in 5 minutes or so.
  83.     If set to zero, automatic pinging will be disabled.
  84.     
  85. REFRESHDELAY/K/N:
  86.     Sets the number of minutes to delay between refreshing your
  87.     list of clients who are logged in to the AmiTrack server.
  88.     If set to zero, automatic list refreshing will be disabled.
  89.  
  90. ENABLED/K:
  91.     If set to NO, AmiTrack will open in "disabled" mode.  In this
  92.     mode, AmiTrack will not register itself with the AmiTrack
  93.     server.  It will still periodically download the list of 
  94.     other clients, however.  Thus, you can "lurk" by specifying
  95.     this option.
  96.     
  97. CX_POPUP/K:
  98.     If set to NO, AmiTrack will not open its window on startup.
  99.  
  100. CX_PRIORITY/K/N:
  101.     Sets the Commodities priority of the AmiTrack commodity.
  102.  
  103. CX_POPKEY/K:
  104.     Sets a hotkey that will cause AmiTrack to open its window.
  105.     Defaults to "lcommand shift a".
  106.  
  107.     
  108. Valid AmiTrack CLI invocations could be:
  109.  
  110.   AmiTrack
  111.  
  112.   AmiTrack "COMMENT=I'm online!"
  113.  
  114.   AmiTrack SERVER=your.mother.com PORT=5217 CX_POPUP=NO "COMMENT=My comment"
  115.  
  116.   AmiTrack "COMMENT=Hi there" "CX_POPKEY=shift help" ENABLED=NO
  117.  
  118.  
  119.  
  120. AMITRACK GUI
  121. ------------
  122. AmiTrack's GUI is fairly straightforward.  It consists of several
  123. string gadgets, two buttons, and a ListView.  The Server, Port, and
  124. Comment string gadgets are self-explanatory (I hope!).  The ListView
  125. shows the IP addresses and comment strings of everyone logged in
  126. to the server you are connected to.  This list may be updated by
  127. clicking on the "Refresh" button, and will also be updated automatically
  128. every few minutes when the window is open, as indicated by the 
  129. associated integer text gadget.  The "Ping" button causes your client to 
  130. send a packet to the AmiTrackServer, in effect saying "I'm here!".  
  131. If the AmiTrackServer does not hear from your client for about five 
  132. minutes straight, it will assume that you are no longer available 
  133. and remove you from its list.  Hence, it is probably a bad idea 
  134. AmiTrack's ping interval to more than about four minutes.
  135.  
  136. Automatic refreshes and pings can be disabled by setting their
  137. interval gadget to zero.
  138.  
  139. AmiTrack can be hidden via the Project menu.  Its window can be
  140. reopened via its hotkey (see the CX_POPKEY argument above) or
  141. by clicking the "Show" button in the Commodities Exchange program.
  142.  
  143. The "Enabled" option in the Project menu controls whether or
  144. not you wish to be visible on the AmiTrackServer's registry.
  145. You can also use the Enable/Disable buttons in the Commodities 
  146. Exchange program is to control this.
  147.  
  148.  
  149. AMITRACKSERVER
  150. --------------
  151. The AmiTrackServer executable is designed to accept AmiTrack
  152. client connections from all over the Internet and dole out
  153. information about who else has connected to it recently.  Most
  154. people won't need this program, but it's there anyway for those
  155. who would like to run their own server.  AmiTrackServer has no
  156. GUI, rather it sends only output to the CLI.  It will display
  157. its list of registered Amigas to the CLI at regular intervals,
  158. and whenever the list is modified.  The list displays the IP
  159. name of each Amiga, its comment string, and the number of seconds
  160. that have elapsed since the last "ping" was heard from that
  161. Amiga.
  162.  
  163. AmiTrackServer takes one optional command line argument, the
  164. port number upon which it is to accept connections.  This number
  165. defaults to 18945.
  166.  
  167. AmiTrackServer will quit if sent a CTRL-C signal, and will
  168. refresh its CLI output of its list if sent a CTRL-D.
  169.  
  170.  
  171. TECHNICAL
  172. ---------
  173. AmiTrack tries to be as reliable and efficient as possible.
  174. The AmiTrack server keeps a linked list of the currently
  175. registered Amiga hostnames and their comment strings, as
  176. well as a timestamp of last time those Amigas were heard from.
  177. If an AmiTrack client has not sent a packet to the server
  178. for a specified amount of time (currently five minutes),
  179. it is liable to be removed from the registered list.  This
  180. way, even if the client crashed and didn't send a disconnect
  181. packet, its entry won't hang around forever.  To retrieve
  182. the list of clients, AmiTrack opens a TCP connection to
  183. the AmiTrack server, which immediately spits out a list of
  184. IP numbers, names, and comment strings, and then closes the
  185. connection.
  186.  
  187. AmiTrack is written in DICE C, but there shouldn't be anything
  188. too compiler-dependent in it.
  189.  
  190.  
  191. MANIFEST
  192. --------
  193. The following files should be in the AmiTrack archive:
  194.  
  195. Listing of archive 'AmiTrack.lha':
  196. Original  Packed Ratio    Date     Time    Name
  197. -------- ------- ----- --------- --------  -------------
  198.      628     274 56.3% 24-Oct-96 01:32:12  AmiTrack.info
  199.    23680   12792 45.9% 24-Oct-96 01:32:12 +AmiTrack
  200.      660     358 45.7% 24-Oct-96 01:32:12 +AmiTrack.info
  201.    13071    5505 57.8% 24-Oct-96 01:32:12 +AmiTrack.readme
  202.      840     295 64.8% 24-Oct-96 01:32:12 +AmiTrack.readme.info
  203.    12288    7475 39.1% 24-Oct-96 01:32:12 +AmiTrackServer
  204.      450     267 40.6% 24-Oct-96 01:32:12 +AmiTrackServer.info
  205.      628     274 56.3% 24-Oct-96 01:32:10 +source.info
  206.    40361   11919 70.4% 24-Oct-96 01:32:12 +amitrack.c
  207.     5992    2139 64.3% 24-Oct-96 01:32:10 +amitrackserver.c
  208.    15097    4871 67.7% 24-Oct-96 01:32:12 +AmiTrackShared.c
  209.     4485    1682 62.4% 24-Oct-96 01:32:12 +amitrackshared.h
  210.     1466     360 75.4% 24-Oct-96 01:32:12 +dmakefile
  211. -------- ------- ----- --------- --------
  212.   119646   48211 59.7% 24-Oct-96 01:32:22   13 files
  213.  
  214.  
  215. AUTHOR
  216. ------
  217. This program was written by Jeremy Friesner, using DICE C.
  218. My email address is jfriesne@ucsd.edu.  (Try jaf@chem.ucsd.edu if
  219. that one doesn't work, though)
  220.  
  221.  
  222. ACKNOWLEDGEMENTS
  223. ----------------
  224. Thanks to Oliver Hotz for providing a full-time AmiTrack server site.
  225.  
  226. Thanks to AndyS and Gallant on #amiga for helping me debug & test.
  227.  
  228. And finally, thanks to the guy who emailed me suggesting most of
  229. the new features for v1.2--unfortunately, my email file got wiped 
  230. and I can't remember your name or address! :(
  231.  
  232.  
  233. DISTRIBUTION
  234. ------------
  235. AmiTrack is fully in the public domain.  Do whatever you want with it.
  236.  
  237.  
  238. BUGS
  239. ----  
  240. - Sometimes after you exit the server, it can't be run again
  241.   for a minute or so afterwards (it will error out, saying the
  242.   TCP port is in use).  This usually happens if GetTrackList has
  243.   been run on this server recently.  I think this is a "feature" 
  244.   of BSD-based TCP software, though, as I've seen the same 
  245.   thing happen on UNIX machines running other software.
  246.  
  247. - There ought to be a mechanism to ensure that you can't set the
  248.   ping interval to be greater than the server's timeout interval.
  249.  
  250. - AmiTrack exits when AmiTCP quits (because AmiTCP sends it a CTRL-C).  
  251.   Perhaps it should still hang around afterwards, in case AmiTCP is 
  252.   started again?
  253.     
  254.  
  255. TODO
  256. ----
  257. - Make a UNIX version of the server, and perhaps the client
  258.   as well.
  259.   
  260. - Add a way to automatically launch your favorite net program
  261.   with a given hostname from the list as an argument.
  262.   
  263.  
  264. OTHER STUFF
  265. -----------
  266. Some other programs I wrote:  (try them, they're cool! ;))
  267.  
  268. GadMget - Loads in an Aminet RECENT or INDEX file and lets you choose
  269.           files to download via a pair of ListViews.  Features keyword
  270.           searching and sorting by name, size, age, directory, and 
  271.           description.  When you're done, it outputs the ftp commands
  272.           that are needed to download the selected files.  The output
  273.           formatting is extremely flexible, allowing generation of 
  274.           many formats:  ftp, ncftp, ftp-by-mail, shell scripts, etc.
  275.           Comes with an ARexx script to completely automate downloading 
  276.           with ncFTP.  (util/misc/GadMget2.05.lha,93K)
  277.   
  278. AmiSlate - A paint program that works with AmiTCP to allow two people
  279.            to cooperatively paint on the same drawing from different
  280.            computers.  Features an extensive ARexx port which allows
  281.            the construction of new features and games.  Comes with
  282.            ARexx scripts for chess, tic-tac-toe, backgammon, and others.
  283.            (comm/tcp/AmiSlate1.4.lha,115K)
  284.  
  285. AmiPhone - An Internet voice-chat program, similar to IPhone and
  286.            VoiceChat and Nevot and all that, only Amiga-specific.
  287.            Features aflexible buffering mechanism for slow connections,
  288.            an ARexx port, IFF 8SVX transmission and playback, internal
  289.            multitasking, and support for a variety of digitizers.
  290.            (comm/net/AmiPhone1.92.lha,142K)
  291.  
  292.  
  293. HISTORY
  294. -------
  295. 1.21 : (Public Release 10/22/96)
  296.      * Oops, a stupid bug crept in that broke the automatic
  297.        pinging and updating.  Sorry about that!
  298.      * Changed key-shortcut for the "About" box to lcommand-?
  299.      - Added a time display to the "logins refreshed" message.
  300.      - Window now retains the previous title bar message after
  301.        being closed and reopened.
  302.        
  303.      
  304. 1.2  : (Public Release 10/22/96)
  305.      - AmiTrack is now a commodity.
  306.      - All the startup arguments have been changed, and new ones have
  307.        been added.
  308.      - Removed the iconify feature--use "Hide" and Commodities instead.
  309.      - AmiTrack can now be started from the Workbench, and parses ToolTypes.
  310.      - AmiTrack no longer requires AmiTCP to be running when AmiTrack
  311.        is launched.  If AmiTrack is launched and AmiTCP is not running,
  312.        then AmiTrack will just wait around quietly until AmiTCP is started.
  313.        This allows AmiTrack to be placed in your WBStartup directory!
  314.      - Added the "Enable" item to the Project menu.
  315.      - Made isys.ml.org the default server
  316.      - Made absolutely no changes to the AmiTrackServer code.
  317.  
  318. 1.11 : (Private Release 10/13/96)
  319.      - Added iconify-on-startup.
  320.  
  321. 1.1  : (Public Release 6/28/96)
  322.      - Separated the AmiTrack server and client into two separate
  323.        programs, and integrated GetTrackList into the client.
  324.      - Added a nice GUI to the client program.
  325.      - The AmiTrack protocol has changed slightly--v1.1 is not quite
  326.        compatible with v1.0.  Sorry!  :(
  327.       
  328. 1.0  : (Public Release 6/7/96)
  329.      - Initial release.  Works well for me, but untested in "real life".
  330.